<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Flow-IPC: ipc::transport::struc::Heap_fixed_builder::Config Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">Flow-IPC<span id="projectnumber">&#160;2.0.0</span>
   </div>
   <div id="projectbrief">Flow-IPC project: Full implementation reference.</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespaceipc.html">ipc</a></li><li class="navelem"><a class="el" href="namespaceipc_1_1transport.html">transport</a></li><li class="navelem"><a class="el" href="namespaceipc_1_1transport_1_1struc.html">struc</a></li><li class="navelem"><a class="el" href="classipc_1_1transport_1_1struc_1_1Heap__fixed__builder.html">Heap_fixed_builder</a></li><li class="navelem"><a class="el" href="structipc_1_1transport_1_1struc_1_1Heap__fixed__builder_1_1Config.html">Config</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="structipc_1_1transport_1_1struc_1_1Heap__fixed__builder_1_1Config-members.html">List of all members</a>  </div>
  <div class="headertitle"><div class="title">ipc::transport::struc::Heap_fixed_builder::Config Struct Reference</div></div>
</div><!--header-->
<div class="contents">

<p>Implements <a class="el" href="structipc_1_1transport_1_1struc_1_1Struct__builder_1_1Config.html" title="Copy-ctible, copy-assignable, default-ctible type – informally, cheaply copyable and likely an aggreg...">Struct_builder::Config</a> sub-concept.  
 <a href="structipc_1_1transport_1_1struc_1_1Heap__fixed__builder_1_1Config.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="heap__serializer_8hpp_source.html">heap_serializer.hpp</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for ipc::transport::struc::Heap_fixed_builder::Config:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="structipc_1_1transport_1_1struc_1_1Heap__fixed__builder_1_1Config__coll__graph.svg" width="244" height="167"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-types" name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a9fa5b2a78f33981eaee67e48de29c73c"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structipc_1_1transport_1_1struc_1_1Heap__fixed__builder_1_1Config.html#a9fa5b2a78f33981eaee67e48de29c73c">Builder</a> = <a class="el" href="classipc_1_1transport_1_1struc_1_1Heap__fixed__builder.html">Heap_fixed_builder</a></td></tr>
<tr class="memdesc:a9fa5b2a78f33981eaee67e48de29c73c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Implements concept API.  <a href="structipc_1_1transport_1_1struc_1_1Heap__fixed__builder_1_1Config.html#a9fa5b2a78f33981eaee67e48de29c73c">More...</a><br /></td></tr>
<tr class="separator:a9fa5b2a78f33981eaee67e48de29c73c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a8e16bef50eeda7c1af3b7caaa862fe73"><td class="memItemLeft" align="right" valign="top">flow::log::Logger *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structipc_1_1transport_1_1struc_1_1Heap__fixed__builder_1_1Config.html#a8e16bef50eeda7c1af3b7caaa862fe73">m_logger_ptr</a></td></tr>
<tr class="memdesc:a8e16bef50eeda7c1af3b7caaa862fe73"><td class="mdescLeft">&#160;</td><td class="mdescRight">Logger to use for logging subsequently.  <a href="structipc_1_1transport_1_1struc_1_1Heap__fixed__builder_1_1Config.html#a8e16bef50eeda7c1af3b7caaa862fe73">More...</a><br /></td></tr>
<tr class="separator:a8e16bef50eeda7c1af3b7caaa862fe73"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9e759098107b22d8e40238eeb74c7f0b"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structipc_1_1transport_1_1struc_1_1Heap__fixed__builder_1_1Config.html#a9e759098107b22d8e40238eeb74c7f0b">m_segment_sz</a></td></tr>
<tr class="memdesc:a9e759098107b22d8e40238eeb74c7f0b"><td class="mdescLeft">&#160;</td><td class="mdescRight">See <code>struct</code> doc header.  <a href="structipc_1_1transport_1_1struc_1_1Heap__fixed__builder_1_1Config.html#a9e759098107b22d8e40238eeb74c7f0b">More...</a><br /></td></tr>
<tr class="separator:a9e759098107b22d8e40238eeb74c7f0b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aeb6fcd8308642adbcb6edcd564375c88"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structipc_1_1transport_1_1struc_1_1Heap__fixed__builder_1_1Config.html#aeb6fcd8308642adbcb6edcd564375c88">m_frame_prefix_sz</a></td></tr>
<tr class="memdesc:aeb6fcd8308642adbcb6edcd564375c88"><td class="mdescLeft">&#160;</td><td class="mdescRight">See <code>struct</code> doc header.  <a href="structipc_1_1transport_1_1struc_1_1Heap__fixed__builder_1_1Config.html#aeb6fcd8308642adbcb6edcd564375c88">More...</a><br /></td></tr>
<tr class="separator:aeb6fcd8308642adbcb6edcd564375c88"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac0f5855ff005915ead9b7b109423408c"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structipc_1_1transport_1_1struc_1_1Heap__fixed__builder_1_1Config.html#ac0f5855ff005915ead9b7b109423408c">m_frame_postfix_sz</a></td></tr>
<tr class="memdesc:ac0f5855ff005915ead9b7b109423408c"><td class="mdescLeft">&#160;</td><td class="mdescRight">See <code>struct</code> doc header.  <a href="structipc_1_1transport_1_1struc_1_1Heap__fixed__builder_1_1Config.html#ac0f5855ff005915ead9b7b109423408c">More...</a><br /></td></tr>
<tr class="separator:ac0f5855ff005915ead9b7b109423408c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p >Implements <a class="el" href="structipc_1_1transport_1_1struc_1_1Struct__builder_1_1Config.html" title="Copy-ctible, copy-assignable, default-ctible type – informally, cheaply copyable and likely an aggreg...">Struct_builder::Config</a> sub-concept. </p>
<p >In this impl: The data members control <a class="el" href="classipc_1_1transport_1_1struc_1_1Heap__fixed__builder.html" title="Implements Struct_builder concept by straightforwardly allocating fixed-size segments on-demand in th...">Heap_fixed_builder</a>'s behavior as follows:</p>
<p ><a class="el" href="classipc_1_1transport_1_1struc_1_1Heap__fixed__builder.html" title="Implements Struct_builder concept by straightforwardly allocating fixed-size segments on-demand in th...">Heap_fixed_builder</a> ctor configured by <a class="el" href="structipc_1_1transport_1_1struc_1_1Heap__fixed__builder_1_1Config.html" title="Implements Struct_builder::Config sub-concept.">Config</a> creates builder that shall heap-allocate segments of the given size on demand subsequently. A successful <a class="el" href="classipc_1_1transport_1_1struc_1_1Heap__fixed__builder.html#a9fb6b2727c7cc0fb8fe7d231385b5517" title="Implements concept API.">Heap_fixed_builder::emit_serialization()</a> call shall return individual segment sizes never exceeding <a class="el" href="structipc_1_1transport_1_1struc_1_1Heap__fixed__builder_1_1Config.html#a9e759098107b22d8e40238eeb74c7f0b" title="See struct doc header.">m_segment_sz</a> (for the [<code>begin()</code>, <code>end()</code>) area), with <code>start() == #m_frame_prefix_sz</code>, and with <code>capacity() - start() - size() &gt;= #m_frame_postfix_sz</code>.</p>
<p >However, internally, larger segments may still be allocated, namely if a <a class="el" href="classipc_1_1transport_1_1struc_1_1Heap__fixed__builder.html#a0c054e351753ce326620aa1dec12d923" title="Implements concept API.">Heap_fixed_builder::payload_msg_builder()</a> mutation supplies a too-large leaf &ndash; but, if this occurs, <a class="el" href="classipc_1_1transport_1_1struc_1_1Heap__fixed__builder.html#a9fb6b2727c7cc0fb8fe7d231385b5517" title="Implements concept API.">Heap_fixed_builder::emit_serialization()</a> shall emit an error and no successful serialization. That said be aware you'll still be charged for the resulting RAM use in the meantime. Informal recommendations:</p><ul>
<li>Do not use <a class="el" href="classipc_1_1transport_1_1struc_1_1Heap__fixed__builder.html" title="Implements Struct_builder concept by straightforwardly allocating fixed-size segments on-demand in th...">Heap_fixed_builder</a> if this is a danger given the schema in question. See <a class="el" href="classipc_1_1transport_1_1struc_1_1Heap__fixed__builder.html" title="Implements Struct_builder concept by straightforwardly allocating fixed-size segments on-demand in th...">Heap_fixed_builder</a> doc header for discussion of alternative approaches.</li>
<li>If the problem does occur (<a class="el" href="classipc_1_1transport_1_1struc_1_1Heap__fixed__builder.html#a9fb6b2727c7cc0fb8fe7d231385b5517" title="Implements concept API.">Heap_fixed_builder::emit_serialization()</a> does emit the error) nevertheless, it is pointless to keep using <code>*this</code>; destroy it and take the appropriate exceptional-error-contingency steps. </li>
</ul>

<p class="definition">Definition at line <a class="el" href="heap__serializer_8hpp_source.html#l00154">154</a> of file <a class="el" href="heap__serializer_8hpp_source.html">heap_serializer.hpp</a>.</p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a id="a9fa5b2a78f33981eaee67e48de29c73c" name="a9fa5b2a78f33981eaee67e48de29c73c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9fa5b2a78f33981eaee67e48de29c73c">&#9670;&nbsp;</a></span>Builder</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">using <a class="el" href="structipc_1_1transport_1_1struc_1_1Heap__fixed__builder_1_1Config.html#a9fa5b2a78f33981eaee67e48de29c73c">ipc::transport::struc::Heap_fixed_builder::Config::Builder</a> =  <a class="el" href="classipc_1_1transport_1_1struc_1_1Heap__fixed__builder.html">Heap_fixed_builder</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Implements concept API. </p>

<p class="definition">Definition at line <a class="el" href="heap__serializer_8hpp_source.html#l00159">159</a> of file <a class="el" href="heap__serializer_8hpp_source.html">heap_serializer.hpp</a>.</p>

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="ac0f5855ff005915ead9b7b109423408c" name="ac0f5855ff005915ead9b7b109423408c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac0f5855ff005915ead9b7b109423408c">&#9670;&nbsp;</a></span>m_frame_postfix_sz</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">size_t ipc::transport::struc::Heap_fixed_builder::Config::m_frame_postfix_sz</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>See <code>struct</code> doc header. </p>

<p class="definition">Definition at line <a class="el" href="heap__serializer_8hpp_source.html#l00170">170</a> of file <a class="el" href="heap__serializer_8hpp_source.html">heap_serializer.hpp</a>.</p>

</div>
</div>
<a id="aeb6fcd8308642adbcb6edcd564375c88" name="aeb6fcd8308642adbcb6edcd564375c88"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aeb6fcd8308642adbcb6edcd564375c88">&#9670;&nbsp;</a></span>m_frame_prefix_sz</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">size_t ipc::transport::struc::Heap_fixed_builder::Config::m_frame_prefix_sz</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>See <code>struct</code> doc header. </p>

<p class="definition">Definition at line <a class="el" href="heap__serializer_8hpp_source.html#l00168">168</a> of file <a class="el" href="heap__serializer_8hpp_source.html">heap_serializer.hpp</a>.</p>

</div>
</div>
<a id="a8e16bef50eeda7c1af3b7caaa862fe73" name="a8e16bef50eeda7c1af3b7caaa862fe73"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8e16bef50eeda7c1af3b7caaa862fe73">&#9670;&nbsp;</a></span>m_logger_ptr</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">flow::log::Logger* ipc::transport::struc::Heap_fixed_builder::Config::m_logger_ptr</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Logger to use for logging subsequently. </p>

<p class="definition">Definition at line <a class="el" href="heap__serializer_8hpp_source.html#l00164">164</a> of file <a class="el" href="heap__serializer_8hpp_source.html">heap_serializer.hpp</a>.</p>

</div>
</div>
<a id="a9e759098107b22d8e40238eeb74c7f0b" name="a9e759098107b22d8e40238eeb74c7f0b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9e759098107b22d8e40238eeb74c7f0b">&#9670;&nbsp;</a></span>m_segment_sz</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">size_t ipc::transport::struc::Heap_fixed_builder::Config::m_segment_sz</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>See <code>struct</code> doc header. </p>

<p class="definition">Definition at line <a class="el" href="heap__serializer_8hpp_source.html#l00166">166</a> of file <a class="el" href="heap__serializer_8hpp_source.html">heap_serializer.hpp</a>.</p>

</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>transport/struc/<a class="el" href="heap__serializer_8hpp_source.html">heap_serializer.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Apr 11 2025 20:02:27 for Flow-IPC by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
</small></address>
</body>
</html>
